Retrieve Services
The Retrieve Services request retrieves the details of a specific service using the Live Platform Id. Use this request to retrieve detailed information for the service.
URI
Copy
{{baseUrl}}api/ovoc/v1/topology/services/
HTTP Method
GET
Request Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
<id> |
string |
Id of the Service in Live Platform portal. |
Example Response
Example of a response for a request without allDetails or allDetails=false in query string:
Copy
{
"services": [
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 11,
"meeting": 15
},
"maxDevicesMeeting": 200,
"maxDevicesPersonal": 200,
"devicesPercentagePersonal": 5,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/20f45b4e-9389-4afd-bc0d-384f6d375810/",
"devicesPercentageMeeting": 7,
"disconnectedDevices": {
"personal": 7,
"meeting": 11
}
},
"lcCustomerId": 79192,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "ERROR",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
42713
],
"licenseType": "PRO_IMTR",
"serviceDeviceId": null,
"attachedLinks": [],
"serviceUcaasTenantId": "a4c1032c-9111-4174-8202-06a56c5b50e3",
"id": 42712,
"serviceId": "20f45b4e-9389-4afd-bc0d-384f6d375810",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-03-15T10:37:35.820+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "DHD Customer A DM",
"usersCount": null,
"serviceName": "customera-dm",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/42712",
"lastBackupTime": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "customera-dm",
"tenantId": 1,
"parameters": [
{
"name": "Max AI Summary Devices",
"type": "Integer",
"value": 5
},
{
"name": "Active AI Summary Devices",
"type": "Integer",
"value": 2
},
{
"name": "AI Summary Status",
"type": "String",
"value": "enabled"
},
{
"name": "email",
"type": "String",
"value": "dhdeang@audiocodes.com"
},
{
"name": "Trial Status",
"type": "String",
"value": "enabled"
},
{
"name": "Trial Expiry Date",
"type": "String",
"value": "19-07-2026"
},
{
"name": "Trial Start Date",
"type": "String",
"value": "20-01-2026"
}
],
"status": "ERROR"
},
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 0,
"meeting": 0
},
"maxDevicesMeeting": 10,
"maxDevicesPersonal": 10,
"devicesPercentagePersonal": 0,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/675426ad-958e-4c4e-8d67-0d7b35d4c48b/",
"devicesPercentageMeeting": 0,
"disconnectedDevices": {
"personal": 0,
"meeting": 0
}
},
"lcCustomerId": 97884,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "OK",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
53905
],
"licenseType": "ESSENTIAL",
"serviceDeviceId": null,
"attachedLinks": [],
"serviceUcaasTenantId": "5bfd35ae-875a-4f06-8df8-6f916432909c",
"id": 53904,
"serviceId": "675426ad-958e-4c4e-8d67-0d7b35d4c48b",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-05-16T12:51:37.590+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "CarlDMDemo",
"usersCount": null,
"serviceName": "CarlDMDemo",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/53904",
"lastBackupTime": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "CarlDMDemo",
"tenantId": 1,
"parameters": null,
"status": "OK"
},
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 0,
"meeting": 0
},
"maxDevicesMeeting": 10,
"maxDevicesPersonal": 10,
"devicesPercentagePersonal": 0,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/da2d3e2f-0a1e-4fa1-afcd-74051107bb95/",
"devicesPercentageMeeting": 0,
"disconnectedDevices": {
"personal": 0,
"meeting": 0
}
},
"lcCustomerId": 97885,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "OK",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
54019
],
"licenseType": "ESSENTIAL",
"serviceDeviceId": null,
"attachedLinks": [],
"serviceUcaasTenantId": "c1341d1d-2cf8-417a-95fc-69a05a2c0d11",
"id": 54018,
"serviceId": "da2d3e2f-0a1e-4fa1-afcd-74051107bb95",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-05-29T11:56:28.410+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "Ami customer",
"usersCount": null,
"serviceName": "Ami_customer",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/54018",
"lastBackupTime": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "Ami_customer",
"tenantId": 1,
"parameters": null,
"status": "OK"
},
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 9,
"meeting": 48
},
"maxDevicesMeeting": 300,
"maxDevicesPersonal": 100,
"devicesPercentagePersonal": 9,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/2913e267-ccab-4974-9d71-462eed586b93/",
"devicesPercentageMeeting": 16,
"disconnectedDevices": {
"personal": 7,
"meeting": 29
}
},
"lcCustomerId": 61954,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "ERROR",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
55150
],
"licenseType": "ESSENTIAL_IMTR",
"serviceDeviceId": null,
"attachedLinks": [],
"serviceUcaasTenantId": "67fea0c1-0319-4f7c-9ae0-7f7de75dbcdd",
"id": 55149,
"serviceId": "2913e267-ccab-4974-9d71-462eed586b93",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-07-09T13:17:23.628+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "Seraya",
"usersCount": null,
"serviceName": "Seraya",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/55149",
"lastBackupTime": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "Seraya",
"tenantId": 1,
"parameters": [
{
"name": "Max AI Summary Devices",
"type": "Integer",
"value": 300
},
{
"name": "Active AI Summary Devices",
"type": "Integer",
"value": 22
},
{
"name": "AI Summary Status",
"type": "String",
"value": "enabled"
},
{
"name": "email",
"type": "String",
"value": "maximge@audiocodes.com"
},
{
"name": "Trial Status",
"type": "String",
"value": "enabled"
},
{
"name": "Trial Expiry Date",
"type": "String",
"value": "06-06-2026"
},
{
"name": "Trial Start Date",
"type": "String",
"value": "08-12-2025"
}
],
"status": "ERROR"
},
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 1,
"meeting": 0
},
"maxDevicesMeeting": 2,
"maxDevicesPersonal": 2,
"devicesPercentagePersonal": 50,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/c07d9550-dbfa-4cde-b0b2-8e230c9106e5/",
"devicesPercentageMeeting": 0,
"disconnectedDevices": {
"personal": 1,
"meeting": 0
}
},
"lcCustomerId": 61972,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "ERROR",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
55708
],
"licenseType": "ESSENTIAL",
"serviceDeviceId": null,
"attachedLinks": [],
"serviceUcaasTenantId": "5029f258-3cac-454d-8e0e-02f8ad7b3883",
"id": 55707,
"serviceId": "c07d9550-dbfa-4cde-b0b2-8e230c9106e5",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-08-01T15:49:11.442+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "ZARonaldM",
"usersCount": null,
"serviceName": "ZARonaldM",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/55707",
"lastBackupTime": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "ZARonaldM",
"tenantId": 1,
"parameters": null,
"status": "ERROR"
},
{
"elementsCount": {
"total": 0,
"devices": 0,
"links": 0,
"sites": 0
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 0,
"meeting": 0
},
"maxDevicesMeeting": 10,
"maxDevicesPersonal": 100,
"devicesPercentagePersonal": 0,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/ed7260d8-e8e4-47c7-988f-04027381d7ba/",
"devicesPercentageMeeting": 0,
"disconnectedDevices": {
"personal": 0,
"meeting": 0
}
},
"lcCustomerId": 62250,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "UNMONITORED",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [],
"licenseType": "PRO",
"serviceDeviceId": null,
"attachedLinks": [],
"serviceUcaasTenantId": "",
"id": 55732,
"serviceId": "ed7260d8-e8e4-47c7-988f-04027381d7ba",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-08-03T16:06:11.294+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "ACME Inc.",
"usersCount": null,
"serviceName": "ACME Inc.",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/55732",
"lastBackupTime": null,
"isEnabled": false,
"totalDIDs": 0,
"name": "ACME Inc.",
"tenantId": 1,
"parameters": [
{
"name": "Unused DIDs",
"type": "Integer",
"value": "0"
},
{
"name": "Used DIDs",
"type": "Integer",
"value": "0"
},
{
"name": "Total DIDs",
"type": "Integer",
"value": "0"
},
{
"name": "Last Backup Time",
"type": "Date",
"value": ""
}
],
"status": "UNMONITORED"
},
{
HTTP Responses
| ■ | 200 OK |
This request retrieves data for all service types, parameters that are not applicable to Direct Routing and Operator Connect services are not included in the table.
|
Parameter |
Type |
Description |
|||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
elementsCount |
dictionary |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
total |
integer |
The total number of entities deployed for the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
links |
integer |
The total number of links deployed for the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
lcCustomerId |
long (1-max long) |
Id of the Live Platform customer. |
|||||||||||||||||||||||||||||||||||||||||||||
|
umpUsersSuspendAlarmStatus |
integer |
||||||||||||||||||||||||||||||||||||||||||||||
|
description |
string (0-100) |
Brief customer description |
|||||||||||||||||||||||||||||||||||||||||||||
|
type |
string |
Service |
|||||||||||||||||||||||||||||||||||||||||||||
|
applicationsStatus |
dictionary |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
management |
dictionary |
managementStatus |
|||||||||||||||||||||||||||||||||||||||||||||
|
managementStatus |
string |
Statuses for the Live Platform Portal Management entity:
|
|||||||||||||||||||||||||||||||||||||||||||||
|
voiceQuality |
dictionary |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
licenseType |
serviceLicenseType |
License type of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceDeviceId |
integer |
The Id of the SBC device attached to the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
attachedLinks |
array of attachments links IDs (Longs) |
List of Ids for attached SIP Connections. |
|||||||||||||||||||||||||||||||||||||||||||||
|
id |
long (node_id sequence) |
Id of the service |
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceId |
string (0-255) |
Live Platform internal service Id |
|||||||||||||||||||||||||||||||||||||||||||||
|
definedAt |
$date-time |
The date and time of the creation of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceSource |
serviceSourceType |
The type of service:
|
|||||||||||||||||||||||||||||||||||||||||||||
|
freeDIDs (Unused DIDS) |
integer (max int) |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
fullName |
string (0-250) |
Full name of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
usersCount |
integer (max int) |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
serviceName |
string (0-100) |
The name of the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
umpUsersCount |
integer (max int) |
The number of used DIDs for Direct Routing and Operator Connect customers. |
|||||||||||||||||||||||||||||||||||||||||||||
|
url |
path |
The Rest URL for performing actions on the service. /ovoc/v1/topology/services/<serviceid> |
|||||||||||||||||||||||||||||||||||||||||||||
|
usedDIDs |
integer (max int) |
M365 user properties including phone number assignment is not supported for Hosted Essentials services.
|
|||||||||||||||||||||||||||||||||||||||||||||
|
Enabled |
boolean |
Indicates whether the Live Platform license is enabled for the service. |
|||||||||||||||||||||||||||||||||||||||||||||
|
totalDIDs |
integer (max int) |
|
|||||||||||||||||||||||||||||||||||||||||||||
|
umpId (CustomerGuid) |
string ($uuid) |
The umpCustomerGuid created in the Live Platform customer tenant SQL database :
This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created. |
|||||||||||||||||||||||||||||||||||||||||||||
|
name |
string |
The name of the service (identical value to "serviceName"). |
|||||||||||||||||||||||||||||||||||||||||||||
|
tenantId |
long (1-max long) |
The Microsoft Entra Tenant Id of the Service Provider. |
|||||||||||||||||||||||||||||||||||||||||||||
|
parameters (Direct Routing custom parameters) |
list array |
This array includes the following parameters:
|
|||||||||||||||||||||||||||||||||||||||||||||
|
Ordered Users |
string |
The Acquired Licenses for the Direct Routing and Operator Connect services that are configured when the service is onboarded. |
|||||||||||||||||||||||||||||||||||||||||||||
|
CAC Profile |
string |
CAC Profile value, for example "8 sessions" | |||||||||||||||||||||||||||||||||||||||||||||
|
Carrier Id |
string |
Carrier Id (SBC Proxy Set), for example
|
|||||||||||||||||||||||||||||||||||||||||||||
|
status |
string |
Management status of the customer:
|
| ■ | 400: Bad Request (e.g., empty request body) |
| ■ | 404: Resource not found or belongs to a different tenant |
| ■ | 409: Conflict when tenant ID validation fails |
| ■ | 500: Internal server error or communication error with Live Platform portal |
| ■ | 503: Service Unavailable when Live Platform portal is not configured |